ly.img:plugin-background-removal/ly.img.editor.plugin.backgroundRemoval/BackgroundRemovalPlugin

BackgroundRemovalPlugin

open class BackgroundRemovalPlugin : EditorConfigurationBuilder

Plugin for background removal. This plugin adds a dedicated button to the Dock that removes the background from the current page.

Constructors

constructor()

Properties

assetLibrary

open var assetLibrary: ScopedProperty<EditorScope, AssetLibrary?>?

bottomPanel

open var bottomPanel: ScopedProperty<EditorScope, EditorComponent<*>?>?

canvasMenu

open var canvasMenu: ScopedProperty<EditorScope, EditorComponent<*>?>?

colorPalette

open var colorPalette: ScopedProperty<EditorScope, List<Color>?>?

config

var config: BackgroundRemovalConfig?

Background removal configuration object. Check BackgroundRemovalPlugin inheritors for available options.

dock

open override var dock: ScopedProperty<EditorScope, EditorComponent<*>?>?

Returns the editor dock with the background removal button inserted by dockModifier.

dockModifier

var dockModifier: HorizontalListBuilderModify<EditorComponent<*>>.(BackgroundRemovalConfig) -> Unit

The Dock modifier in order to place the Dock.Button.rememberBackgroundRemoval button. By default, it is prepended to the dock.

editorContext

val EditorConfigurationBuilder.editorContext: EditorContext

inspectorBar

open var inspectorBar: ScopedProperty<EditorScope, EditorComponent<*>?>?

navigationBar

open var navigationBar: ScopedProperty<EditorScope, EditorComponent<*>?>?

onClose

open var onClose: suspend EditorScope.() -> Unit?

onCreate

open override var onCreate: suspend EditorScope.() -> Unit?

Initializes the configured background remover after the parent configuration is created.

onError

open var onError: suspend EditorScope.(Throwable) -> Unit?

onEvent

open var onEvent: EditorScope.(EditorEvent) -> Unit?

onExport

open var onExport: suspend EditorScope.() -> Unit?

onLoaded

open var onLoaded: suspend EditorScope.() -> Unit?

onUpload

open var onUpload: suspend EditorScope.(AssetDefinition, UploadAssetSourceType) -> AssetDefinition?

overlay

open var overlay: ScopedProperty<EditorScope, EditorComponent<*>?>?

parentConfiguration

val parentConfiguration: EditorConfiguration?